package com.zzl.springboot_mybatis_demo.configuration;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 温馨提醒：其实这个配置类，只要了解具体能配置哪些东西就好了，毕竟这个东西配置一次之后就不用再动了。
 * 特别要注意的是里面配置了api文件也就是controller包的路径，不然生成的文档扫描不到接口。
 * description: Swagger2配置类
 * @author 朱正磊
 * @date 2019-12-10 11:17:17
 */
@Configuration
public class Swagger2Config {

    /**
     * description: 创建请求的API接口文档
     * @author 朱正磊
     * @date 2019-12-10 11:20:09
     * @return 返回Bean对象
     */
    @Bean
    public Docket createRequestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 如果对所有的API请求都生效，也可以使用RequestHandlerSelectors.any()
                // 设置basePackage会将包下的所有类的所有方法作为api
                // .apis(RequestHandlerSelectors.basePackage("com.zzl.springboot_mybatis_demo.controller.web"))
                // 只有标记@ApiOperation才会暴露出给swagger
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 通过regex可以匹配需要过滤的请求地址
                // .paths(PathSelectors.regex("/api/.*"))
                // PathSelectors.any()表示会过滤所有的请求地址
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * description: 构建API对象信息
     * @author 朱正磊
     * @date 2019-12-10 11:20:15
     * @return 返回ApiInfo对象实例
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 大标题
                .title("来鸭洗车API接口文档")
                // 详细描述
                .description("简单优雅的restful风格，https://maven.aliyun.com/mvn/search 关键字搜索 yongzhuzl")
                // 服务条款网址
                .termsOfServiceUrl("https://search.maven.org/artifact/com.gitee.yongzhuzl/commonutil")
                // 作者
                .contact(new Contact("yongzhuzl", "https://gitee.com/yongzhuzl/commonutil", "2474089165@qq.com"))
                // 许可证
                .license("The Apache License, Version 2.0")
                // 许可证地址
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                // 版本
                .version("1.0")
                .build();
    }

}
